<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilplmi: XilPlmi Client Example APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilplmi
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xplmi__client__example__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilPlmi Client Example APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaea7146263ccd4ebba8e2f1ce94b3de42"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gaea7146263ccd4ebba8e2f1ce94b3de42">IMG_STORE_SRC</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:gaea7146263ccd4ebba8e2f1ce94b3de42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source for Image store.  <a href="#gaea7146263ccd4ebba8e2f1ce94b3de42">More...</a><br/></td></tr>
<tr class="separator:gaea7146263ccd4ebba8e2f1ce94b3de42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26c3bbc23f659d18e5ad594d43639efd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga26c3bbc23f659d18e5ad594d43639efd">PDI_ID</a>&#160;&#160;&#160;(0x5)</td></tr>
<tr class="memdesc:ga26c3bbc23f659d18e5ad594d43639efd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image store address.  <a href="#ga26c3bbc23f659d18e5ad594d43639efd">More...</a><br/></td></tr>
<tr class="separator:ga26c3bbc23f659d18e5ad594d43639efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7b812ba4543afb8805f75f8ba93ddb0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gae7b812ba4543afb8805f75f8ba93ddb0">DDR_SRC</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:gae7b812ba4543afb8805f75f8ba93ddb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source for DDR.  <a href="#gae7b812ba4543afb8805f75f8ba93ddb0">More...</a><br/></td></tr>
<tr class="separator:gae7b812ba4543afb8805f75f8ba93ddb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4018ec3ba4d63ff7eaacf4e8697e5845"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga4018ec3ba4d63ff7eaacf4e8697e5845">DDR_ADDR</a>&#160;&#160;&#160;(0x1000000U)</td></tr>
<tr class="memdesc:ga4018ec3ba4d63ff7eaacf4e8697e5845"><td class="mdescLeft">&#160;</td><td class="mdescRight">DDR address.  <a href="#ga4018ec3ba4d63ff7eaacf4e8697e5845">More...</a><br/></td></tr>
<tr class="separator:ga4018ec3ba4d63ff7eaacf4e8697e5845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad094f3d93865734c4e82d34ef6616894"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gad094f3d93865734c4e82d34ef6616894">EXAMPLE_SEEDLIFE</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:gad094f3d93865734c4e82d34ef6616894"><td class="mdescLeft">&#160;</td><td class="mdescRight">Seed life value.  <a href="#gad094f3d93865734c4e82d34ef6616894">More...</a><br/></td></tr>
<tr class="separator:gad094f3d93865734c4e82d34ef6616894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga50bc47889e36ccd506a9cdf1528b050b">PDI_SRC_ADDR</a>&#160;&#160;&#160;(0x1000000U)</td></tr>
<tr class="memdesc:ga50bc47889e36ccd506a9cdf1528b050b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pdi address.  <a href="#ga50bc47889e36ccd506a9cdf1528b050b">More...</a><br/></td></tr>
<tr class="separator:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7b7dc9a200cb1404c280bd500fd1551"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gaf7b7dc9a200cb1404c280bd500fd1551">BUFFER_LENGTH</a>&#160;&#160;&#160;(0x400000U)</td></tr>
<tr class="memdesc:gaf7b7dc9a200cb1404c280bd500fd1551"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of debug log buffer in words.  <a href="#gaf7b7dc9a200cb1404c280bd500fd1551">More...</a><br/></td></tr>
<tr class="separator:gaf7b7dc9a200cb1404c280bd500fd1551"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga50bc47889e36ccd506a9cdf1528b050b">PDI_SRC_ADDR</a>&#160;&#160;&#160;(0x1000000U)</td></tr>
<tr class="memdesc:ga50bc47889e36ccd506a9cdf1528b050b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pdi address.  <a href="#ga50bc47889e36ccd506a9cdf1528b050b">More...</a><br/></td></tr>
<tr class="separator:ga50bc47889e36ccd506a9cdf1528b050b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae049ba3c12f14ec60a618ed1b69caaa1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gae049ba3c12f14ec60a618ed1b69caaa1">BUF_TOTAL_SIZE</a>&#160;&#160;&#160;(0x108U)</td></tr>
<tr class="memdesc:gae049ba3c12f14ec60a618ed1b69caaa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of Board params.  <a href="#gae049ba3c12f14ec60a618ed1b69caaa1">More...</a><br/></td></tr>
<tr class="separator:gae049ba3c12f14ec60a618ed1b69caaa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gada1b772f34f400391e857ce8189e9efe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gada1b772f34f400391e857ce8189e9efe">GD_STATUS_OFFSET</a>&#160;&#160;&#160;0x00004</td></tr>
<tr class="memdesc:gada1b772f34f400391e857ce8189e9efe"><td class="mdescLeft">&#160;</td><td class="mdescRight">GD_STATUS register offset.  <a href="#gada1b772f34f400391e857ce8189e9efe">More...</a><br/></td></tr>
<tr class="separator:gada1b772f34f400391e857ce8189e9efe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf114951489d482a90a9f58ff288984e9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gaf114951489d482a90a9f58ff288984e9">RESET_GD_STATUS_VAL</a>&#160;&#160;&#160;0x02000200U</td></tr>
<tr class="memdesc:gaf114951489d482a90a9f58ff288984e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to reset glitch detectors.  <a href="#gaf114951489d482a90a9f58ff288984e9">More...</a><br/></td></tr>
<tr class="separator:gaf114951489d482a90a9f58ff288984e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6418598d352531c9382fa4d4b7f6656"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gae6418598d352531c9382fa4d4b7f6656">GD_IRQ_STATUS_CLEAR</a>&#160;&#160;&#160;0x80000000U</td></tr>
<tr class="memdesc:gae6418598d352531c9382fa4d4b7f6656"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to clear IRQ status of glitch detector.  <a href="#gae6418598d352531c9382fa4d4b7f6656">More...</a><br/></td></tr>
<tr class="separator:gae6418598d352531c9382fa4d4b7f6656"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga32dd96c26db1fe40fcfe9d82b4469cff"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga32dd96c26db1fe40fcfe9d82b4469cff">GD0_TEST_GLITCH_GENVALUE</a>&#160;&#160;&#160;0x00F800FEU</td></tr>
<tr class="memdesc:ga32dd96c26db1fe40fcfe9d82b4469cff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to generate test glitch on glitch detector0.  <a href="#ga32dd96c26db1fe40fcfe9d82b4469cff">More...</a><br/></td></tr>
<tr class="separator:ga32dd96c26db1fe40fcfe9d82b4469cff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0a46cdc9a668d6db17423996b541a421"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga0a46cdc9a668d6db17423996b541a421">GD1_TEST_GLITCH_GENVALUE</a>&#160;&#160;&#160;0x00FE00F8U</td></tr>
<tr class="memdesc:ga0a46cdc9a668d6db17423996b541a421"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to generate test glitch on glitch detector1.  <a href="#ga0a46cdc9a668d6db17423996b541a421">More...</a><br/></td></tr>
<tr class="separator:ga0a46cdc9a668d6db17423996b541a421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa683e3c6282317704413cf5c1368dce6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gaa683e3c6282317704413cf5c1368dce6">GD_TEST_GLITCH_STOPVALUE</a>&#160;&#160;&#160;0x00F800F8U</td></tr>
<tr class="memdesc:gaa683e3c6282317704413cf5c1368dce6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to stop test glitch generation on both the glitch detectors.  <a href="#gaa683e3c6282317704413cf5c1368dce6">More...</a><br/></td></tr>
<tr class="separator:gaa683e3c6282317704413cf5c1368dce6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf085f0e2624130dd2e4f2ccbfeef7391"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gaf085f0e2624130dd2e4f2ccbfeef7391">GLITCH_DETECTOR0</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:gaf085f0e2624130dd2e4f2ccbfeef7391"><td class="mdescLeft">&#160;</td><td class="mdescRight">Glitch detector0 number.  <a href="#gaf085f0e2624130dd2e4f2ccbfeef7391">More...</a><br/></td></tr>
<tr class="separator:gaf085f0e2624130dd2e4f2ccbfeef7391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d5cef9f02ec36417bb9b7c87aa60144"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga6d5cef9f02ec36417bb9b7c87aa60144">GLITCH_DETECTOR1</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga6d5cef9f02ec36417bb9b7c87aa60144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Glitch detector1 number.  <a href="#ga6d5cef9f02ec36417bb9b7c87aa60144">More...</a><br/></td></tr>
<tr class="separator:ga6d5cef9f02ec36417bb9b7c87aa60144"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad39f1731ef84b684c0621fb59966d0bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gad39f1731ef84b684c0621fb59966d0bc">DEFAULT_DEPTH_VAL</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:gad39f1731ef84b684c0621fb59966d0bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default depth value.  <a href="#gad39f1731ef84b684c0621fb59966d0bc">More...</a><br/></td></tr>
<tr class="separator:gad39f1731ef84b684c0621fb59966d0bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e7764cd214bd0b121c4038790f02488"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga7e7764cd214bd0b121c4038790f02488">DEFAULT_WIDTH_VAL</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga7e7764cd214bd0b121c4038790f02488"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default width value.  <a href="#ga7e7764cd214bd0b121c4038790f02488">More...</a><br/></td></tr>
<tr class="separator:ga7e7764cd214bd0b121c4038790f02488"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga450fc3998f2afadc7c7a63c351311080"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga450fc3998f2afadc7c7a63c351311080">DEFAULT_REFVOL_VAL</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga450fc3998f2afadc7c7a63c351311080"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default reference voltage value.  <a href="#ga450fc3998f2afadc7c7a63c351311080">More...</a><br/></td></tr>
<tr class="separator:ga450fc3998f2afadc7c7a63c351311080"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8285a6e55c81192ac85c22109d774a85"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga8285a6e55c81192ac85c22109d774a85">DEFAULT_USERREG_VAL</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga8285a6e55c81192ac85c22109d774a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default user reg value.  <a href="#ga8285a6e55c81192ac85c22109d774a85">More...</a><br/></td></tr>
<tr class="separator:ga8285a6e55c81192ac85c22109d774a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga288dd6c0b364007ccaab7925fca03f3d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga288dd6c0b364007ccaab7925fca03f3d">XPLMI_SET</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga288dd6c0b364007ccaab7925fca03f3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set value.  <a href="#ga288dd6c0b364007ccaab7925fca03f3d">More...</a><br/></td></tr>
<tr class="separator:ga288dd6c0b364007ccaab7925fca03f3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga181bebe1afc9566805bcb3088b49a3fb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga181bebe1afc9566805bcb3088b49a3fb">XPLMI_RESET</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga181bebe1afc9566805bcb3088b49a3fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset value.  <a href="#ga181bebe1afc9566805bcb3088b49a3fb">More...</a><br/></td></tr>
<tr class="separator:ga181bebe1afc9566805bcb3088b49a3fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga74c344dff3059d963385046f676560c9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga74c344dff3059d963385046f676560c9">GICP4_IRQ_STATUS_ADDR</a>&#160;&#160;&#160;0xF1140050</td></tr>
<tr class="memdesc:ga74c344dff3059d963385046f676560c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">GICP4_IRQ_STATUS register address.  <a href="#ga74c344dff3059d963385046f676560c9">More...</a><br/></td></tr>
<tr class="separator:ga74c344dff3059d963385046f676560c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga98a2366f9ef44f0d3eee7d33981bbe8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga98a2366f9ef44f0d3eee7d33981bbe8a">RESPONSE</a>&#160;&#160;&#160;(0x8)</td></tr>
<tr class="memdesc:ga98a2366f9ef44f0d3eee7d33981bbe8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Response for trigger BBRAM erase valid tamper responses are 0x8 BBRAM erase 0x4 Secure lockdown 1 0x2 Secure lockdown 0 0x1 System reset 0x0 Reserved.  <a href="#ga98a2366f9ef44f0d3eee7d33981bbe8a">More...</a><br/></td></tr>
<tr class="separator:ga98a2366f9ef44f0d3eee7d33981bbe8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#ga840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:ga840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the ExtractMetaheader example function.  <a href="#ga840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:ga840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9bb7e9b3e6ecd79146a742fc0af0ffc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xplmi__client__example__apis.html#gaf9bb7e9b3e6ecd79146a742fc0af0ffc">GenerateTestGlitch</a> (u8 GdNum)</td></tr>
<tr class="memdesc:gaf9bb7e9b3e6ecd79146a742fc0af0ffc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function generates glitch on given glitch detector.  <a href="#gaf9bb7e9b3e6ecd79146a742fc0af0ffc">More...</a><br/></td></tr>
<tr class="separator:gaf9bb7e9b3e6ecd79146a742fc0af0ffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gae049ba3c12f14ec60a618ed1b69caaa1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define BUF_TOTAL_SIZE&#160;&#160;&#160;(0x108U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size of Board params. </p>

</div>
</div>
<a class="anchor" id="gaf7b7dc9a200cb1404c280bd500fd1551"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define BUFFER_LENGTH&#160;&#160;&#160;(0x400000U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Length of debug log buffer in words. </p>

</div>
</div>
<a class="anchor" id="ga4018ec3ba4d63ff7eaacf4e8697e5845"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DDR_ADDR&#160;&#160;&#160;(0x1000000U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>DDR address. </p>

</div>
</div>
<a class="anchor" id="gae7b812ba4543afb8805f75f8ba93ddb0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DDR_SRC&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source for DDR. </p>

</div>
</div>
<a class="anchor" id="gad39f1731ef84b684c0621fb59966d0bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEFAULT_DEPTH_VAL&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default depth value. </p>

</div>
</div>
<a class="anchor" id="ga450fc3998f2afadc7c7a63c351311080"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEFAULT_REFVOL_VAL&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default reference voltage value. </p>

</div>
</div>
<a class="anchor" id="ga8285a6e55c81192ac85c22109d774a85"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEFAULT_USERREG_VAL&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default user reg value. </p>

</div>
</div>
<a class="anchor" id="ga7e7764cd214bd0b121c4038790f02488"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DEFAULT_WIDTH_VAL&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default width value. </p>

</div>
</div>
<a class="anchor" id="gad094f3d93865734c4e82d34ef6616894"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define EXAMPLE_SEEDLIFE&#160;&#160;&#160;(3U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Seed life value. </p>

</div>
</div>
<a class="anchor" id="ga32dd96c26db1fe40fcfe9d82b4469cff"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GD0_TEST_GLITCH_GENVALUE&#160;&#160;&#160;0x00F800FEU</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Value to generate test glitch on glitch detector0. </p>

<p>Referenced by <a class="el" href="group__xplmi__client__example__apis.html#gaf9bb7e9b3e6ecd79146a742fc0af0ffc">GenerateTestGlitch()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0a46cdc9a668d6db17423996b541a421"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GD1_TEST_GLITCH_GENVALUE&#160;&#160;&#160;0x00FE00F8U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Value to generate test glitch on glitch detector1. </p>

</div>
</div>
<a class="anchor" id="gae6418598d352531c9382fa4d4b7f6656"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GD_IRQ_STATUS_CLEAR&#160;&#160;&#160;0x80000000U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Value to clear IRQ status of glitch detector. </p>

</div>
</div>
<a class="anchor" id="gada1b772f34f400391e857ce8189e9efe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GD_STATUS_OFFSET&#160;&#160;&#160;0x00004</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GD_STATUS register offset. </p>

</div>
</div>
<a class="anchor" id="gaa683e3c6282317704413cf5c1368dce6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GD_TEST_GLITCH_STOPVALUE&#160;&#160;&#160;0x00F800F8U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Value to stop test glitch generation on both the glitch detectors. </p>

</div>
</div>
<a class="anchor" id="ga74c344dff3059d963385046f676560c9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GICP4_IRQ_STATUS_ADDR&#160;&#160;&#160;0xF1140050</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>GICP4_IRQ_STATUS register address. </p>

</div>
</div>
<a class="anchor" id="gaf085f0e2624130dd2e4f2ccbfeef7391"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GLITCH_DETECTOR0&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Glitch detector0 number. </p>

</div>
</div>
<a class="anchor" id="ga6d5cef9f02ec36417bb9b7c87aa60144"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GLITCH_DETECTOR1&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Glitch detector1 number. </p>

</div>
</div>
<a class="anchor" id="gaea7146263ccd4ebba8e2f1ce94b3de42"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define IMG_STORE_SRC&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source for Image store. </p>

</div>
</div>
<a class="anchor" id="ga26c3bbc23f659d18e5ad594d43639efd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_ID&#160;&#160;&#160;(0x5)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Image store address. </p>

</div>
</div>
<a class="anchor" id="ga50bc47889e36ccd506a9cdf1528b050b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_SRC_ADDR&#160;&#160;&#160;(0x1000000U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pdi address. </p>

</div>
</div>
<a class="anchor" id="ga50bc47889e36ccd506a9cdf1528b050b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PDI_SRC_ADDR&#160;&#160;&#160;(0x1000000U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pdi address. </p>

</div>
</div>
<a class="anchor" id="gaf114951489d482a90a9f58ff288984e9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define RESET_GD_STATUS_VAL&#160;&#160;&#160;0x02000200U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Value to reset glitch detectors. </p>

</div>
</div>
<a class="anchor" id="ga98a2366f9ef44f0d3eee7d33981bbe8a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define RESPONSE&#160;&#160;&#160;(0x8)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Response for trigger BBRAM erase valid tamper responses are 0x8 BBRAM erase 0x4 Secure lockdown 1 0x2 Secure lockdown 0 0x1 System reset 0x0 Reserved. </p>

</div>
</div>
<a class="anchor" id="ga181bebe1afc9566805bcb3088b49a3fb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_RESET&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset value. </p>

</div>
</div>
<a class="anchor" id="ga288dd6c0b364007ccaab7925fca03f3d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_SET&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set value. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf9bb7e9b3e6ecd79146a742fc0af0ffc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GenerateTestGlitch </td>
          <td>(</td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>GdNum</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function generates glitch on given glitch detector. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">GdNum</td><td>is the glitch detector number </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="group__xplmi__client__example__apis.html#ga32dd96c26db1fe40fcfe9d82b4469cff">GD0_TEST_GLITCH_GENVALUE</a>.</p>

</div>
</div>
<a class="anchor" id="ga840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the ExtractMetaheader example function. </p>
<p>Main function to call the Load DDR Copy Image example function.</p>
<p>Main function to call the config secure communication function.</p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS on success.</li>
<li>Error code on failure.</li>
</ul>
</dd>
<dd>
<ul>
<li>XST_SUCCESS on success.</li>
<li>XST_FAILURE on failure.</li>
</ul>
</dd>
<dd>
<ul>
<li>Handoff to the ROM on success.</li>
<li>Error code on failure. </li>
</ul>
</dd></dl>
<p>Invoke Generate for IV, SharedMem contains random data from this call. Only 12 bytes will be used for each IV</p>
<p>To generate glitch using test mode, configure glitch detectors with default values. To configure glitch detector to detect glitch of at least 5% depth, 1ns width with 0.7V reference voltage, provide Depth = 0x0E, Width = 0x01, RefVoltage = 0x04.To select the register values instead of efuse values, provide UserRegVal = 0x01</p>

<p>References <a class="el" href="group__xilplmi__mailbox__apis.html#gaea4605770a6e4090bac10578131ca925">XPlmi_ClientInit()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
